eeprom16.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef EEPROM16_H
#define EEPROM16_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define EEPROM16_OPCODE_WREN                            0x06
#define EEPROM16_OPCODE_WRDI                            0x04
#define EEPROM16_OPCODE_RDSR                            0x05
#define EEPROM16_OPCODE_WRSR                            0x01
#define EEPROM16_OPCODE_READ                            0x03
#define EEPROM16_OPCODE_WRITE                           0x02
 // eeprom16_reg



#define EEPROM16_STATUS_WPEN_MASK                       0x80
#define EEPROM16_STATUS_IPL_MASK                        0x40
#define EEPROM16_STATUS_BLOCK_PROTECT_NONE              0x00
#define EEPROM16_STATUS_BLOCK_PROTECT_UPPER_QUARTER     0x04
#define EEPROM16_STATUS_BLOCK_PROTECT_UPPER_HALF        0x08
#define EEPROM16_STATUS_BLOCK_PROTECT_ALL               0x0C
#define EEPROM16_STATUS_BLOCK_PROTECT_MASK              0x0C
#define EEPROM16_STATUS_WEL_MASK                        0x02
#define EEPROM16_STATUS_RDY_MASK                        0x01

#define EEPROM16_MIN_ADDRESS                            0x0000
#define EEPROM16_MAX_ADDRESS                            0x0FFF
#define EEPROM16_PAGE_SIZE                              32
#define EEPROM16_PAGE_MASK                              0x1F

#define EEPROM16_SET_DATA_SAMPLE_EDGE                   SET_SPI_DATA_SAMPLE_EDGE
#define EEPROM16_SET_DATA_SAMPLE_MIDDLE                 SET_SPI_DATA_SAMPLE_MIDDLE
 // eeprom16_set



#define EEPROM16_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.wp   = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.hold = MIKROBUS( mikrobus, MIKROBUS_INT )
 // eeprom16_map // eeprom16

typedef struct
{
    // Output pins
    digital_out_t wp;           
    digital_out_t hold;         
 
    // Modules
    spi_master_t spi;           
 
    pin_name_t   chip_select;   
 
} eeprom16_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
 
    // Additional gpio pins
    pin_name_t wp;              
    pin_name_t hold;            
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
} eeprom16_cfg_t;

typedef enum
{
    EEPROM16_OK = 0,
    EEPROM16_ERROR = -1
 
} eeprom16_return_value_t;


void eeprom16_cfg_setup ( eeprom16_cfg_t *cfg );

err_t eeprom16_init ( eeprom16_t *ctx, eeprom16_cfg_t *cfg );

err_t eeprom16_default_cfg ( eeprom16_t *ctx );

err_t eeprom16_write_opcode ( eeprom16_t *ctx, uint8_t opcode );

err_t eeprom16_read_opcode ( eeprom16_t *ctx, uint8_t opcode, uint8_t *data_out, uint8_t len );

void eeprom16_set_wp_pin ( eeprom16_t *ctx, uint8_t state );

void eeprom16_set_hold_pin ( eeprom16_t *ctx, uint8_t state );

err_t eeprom16_enable_write ( eeprom16_t *ctx );

err_t eeprom16_disable_write ( eeprom16_t *ctx );

err_t eeprom16_set_block_protection ( eeprom16_t *ctx, uint8_t block_protect );

err_t eeprom16_write_status ( eeprom16_t *ctx, uint8_t status );

err_t eeprom16_read_status ( eeprom16_t *ctx, uint8_t *status );

err_t eeprom16_memory_write ( eeprom16_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );

err_t eeprom16_memory_read ( eeprom16_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM16_H
 // eeprom16
 
// ------------------------------------------------------------------------ END